Skip to main content

Composition Tracking – Required Attributes and Categories

The Composition Tracking Analysis Rule requires that elements have specific Attributes and specific Attribute properties. Input and Output Attributes must be configured to be an allowable value type and have specific units of measure. Input and Output Attributes required for the Composition Analysis Rule are listed in these sections:

  • Required Mass or Volume Balance Attributes categories
  • SF_AnalysisInput
  • SF_CaseInputData
  • SF_AnalysisOutput
  • SF_CaseResults
  • Required Composition Tracking categories
  • SF_CompositionResults
  • SF_CompositionTracking
  • SF_CompTrackingCase
  • Required Mass or Volume Balance Input Attributes – Inventories, Meters and Transfers

Note: Selection of these Attributes is not applicable if you select Option 1 – Solve with Reconciled Source Values, found in the \topic Balancing Rules.

Required Composition Tracking Input Attributes (Inventories, Nodes, Processes, Receipts, Shipments and Flows)

Configuration Parameter 1Default Attribute NameAttribute UOMAttribute CategoryAttribute Value Type
Mixing ModelMixingModel 2 3\<none>SF_AnalysisInputString
CompositionCompositionTrackingResults\<none>SF_AnalysisOutputSF_CompositionResultsAnything
Flow MaterialMaterial\<none>SF_AnalysisInputSF_CompositionTrackingString
Composition Balance Flag 1CompositionTrackingBalanceFlag 3\<none>Boolean
1This Attribute is not required for the configuration, but should be in every balance and boundary object templates (Tanks, Process, Nodes, Manifolds, Receipts, Shipments) to indicate to the solver to perform Composition Tracking in that object if this flag is set to TRUE2 Only required for tank elements3 Not required for flow elements 3

Required Mass or Volume Balance Output Attribute (Inventories, Meters, Transfers and Flows)

Configuration Parameter 1Default Attribute NameAttribute UOMAttribute CategoryAttribute Value Type
Reconciled MeasurementReconciledMassReconciledVolumeMass or VolumeSF_AnalysisOutputDouble
SolvabilityReconciledMassSolvabilityReconciledVolumeSolvability\<none>SF_AnalysisOutputString
Reconciled AdjustmentReconciledMassCorrectionReconciledVolumeCorrectionMass or VolumeSF_AnalysisOutputDouble
Initial ImbalanceReconciledMassImbalnceReconciledVolumeImbalanceMass or VolumeSF_AnalysisOutputDouble
Reconciled ResidualReconciledResidual\<none>SF_AnalysisOutputDouble

Required Composition Tracking Output Attributes (Inventories, Nodes, Processes, Receipts and Shipments)

Configuration Parameter 1Default Attribute NameAttribute UOMAttribute CategoryAttribute Value Type
CompositionCompositionTrackingResults\<none>SF_AnalysisOutputSF_CompositionResultsAnything
Composition DensityCompositionTrackingDensityDensity or SpecificGravitySF_AnalysisOutputSF_CompositionResultsDouble
Composition Quality 1CompositionTrackingQualityAny unit of measure 2SF_AnalysisOutputSF_CompositionResultsDouble
Composition Imbalance 1 3CompositionTrackingImbalance\<none>SF_AnalysisOutputSF_CompositionResultsDouble
Composition diagnostic 1CompositionTrackingDiagnostic\<none>SF_AnalysisOutputSF_CompositionResultsInt32
1 This configuration parameter is optional.2 The UOM class must be according the UOM class configured on the selected Material table quality column. For example: If the selected quality is a temperature then, the Composition Quality UOM can be °C,, K or °R.3 The composition imbalance is calculated by the following formula:Where:Qi = Quantity of each single input materialQy = Quantity of each single output materialΔS = Tank delta stock